-
Notifications
You must be signed in to change notification settings - Fork 47
DOCS-1464: Remove ModelAttributes #2313
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
DOCS-1464: Remove ModelAttributes #2313
Conversation
Overall readability score: 56.55 (🟢 +0)
View detailed metrics🟢 - Shows an increase in readability
Averages:
View metric targets
|
You can view a rendered version of the docs from this PR at https://docs-test.viam.dev/2313 |
@penguinland Hi! Here's a docs update that appears to be as simple as it looks! Let me know if you'd like to see any changes -- thank you! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM! The only thing that needs updating is my responsibility. 😖
|
||
**Returns:** | ||
|
||
- [(Attributes)](https://python.viam.dev/autoapi/viam/components/board/index.html#viam.components.board.Board.Attributes): Attributes related to the model of this board. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👀 That link shouldn't exist any more but it does! and it does because I forgot to delete the Attributes
class even though it's no longer used. I'll go make a follow-up PR, and when that's in, the docs at this link should automatically update to match. I'm glad I saw this and noticed my mistake.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Oh! No worries, thanks for catching -- and teaching me about the process!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Linking things up: the follow-up PR is viamrobotics/viam-python-sdk#501
This should have been removed in #491, but I forgot. It's dead code. Grepping the codebase for `Attributes` turns up only 1 result (in src/viam/errors.py), and that's a false positive. Linking things up: I noticed this while reviewing viamrobotics/docs#2313
This should have been removed in #491, but I forgot. It's dead code. Grepping the codebase for `Attributes` turns up only 1 result (in src/viam/errors.py), and that's a false positive. Linking things up: I noticed this while reviewing viamrobotics/docs#2313
Remove ModelAttributes from (docs.viam.com) SDK documentation.